Events - CSV File Formats
Event data can be imported from and exported to InfoWorks CSV file format:
- The use of field headers allows for flexibility in the ordering of fields and permits fields to be easily omitted if desired.
- Units specification is optional. If the units are not specified then they are assumed to be the current user display units.
- Subevent Properties and Profile Properties are specified in "Global" and "Local" rows of the file.
- An optional date/time column alongside the time varying value columns may be included. InfoWorks ICM derives the timestep from the relative values in the date/time column and inserts subevents at any point where the timestep changes.
- If the date/time column is not used, a fixed timestep and a start date must be specified. Multiple events can be imported from one CSV file; for each subevent include "Global" and "Local" rows before the sub-event values.
Click on the event type below to display detailed information describing the appropriate format for these files.
Below is an example of a Rainfall event that has been exported from InfoWorks ICM to CSV format when a user right-clicks on the event and chooses Export | to CSV from the popup menu:
File Header Row |
Description |
||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Version |
Always set to: !Version=2,type=RED,charset=UTF8 |
||||||||||||||||||||||||||||||||
FILECONT TITLE |
FILECONT is a mandatory field which determines the type of event data contained in the file. For a Rainfall even the value in this field should be 0, 1, 8 or 9. TITLE contains the name of the event item. |
||||||||||||||||||||||||||||||||
UserSettings UserSettingsValues |
Units and date-time format are specified in these fields. Units supported by InfoWorks ICM may be specified. Where units are not specified,InfoWorks ICM assumes values in the CSV file are in the current display units.
|
||||||||||||||||||||||||||||||||
Sub-Event Properties |
The fields describing sub-event (global) properties are as below. See the Sub-Event Properties Dialog topic for more details on Sub-Event Property fields. The G_NPROFILES field is mandatory. If this field is incorrect, data will not be imported as expected. At least one of G_TS (the timestep value) and P_DATETIME (the date-time column) must be provided. If both are present the G_TS value is used in conjunction with the G_START value to determine hydrograph timesteps and start time.
|
||||||||||||||||||||||||||||||||
Profile Properties |
The lines describing profile (local) properties are optional. If the CSV files contains local properties field headers, a line for each profile must be included in the file (even if this is an empty line). See the Profile Properties Dialog topic for more information on Profile Property fields.
|
||||||||||||||||||||||||||||||||
Local Profile Information |
The lines describing profile (local) properties are optional. If the CSV files contains local properties field headers, a line for each profile must be included in the file (even if this is an empty line). See the Profile Properties Dialog topic for more information on Profile Property fields.
|
||||||||||||||||||||||||||||||||
Local additional data |
The lines describing profile (local) properties are optional. If the CSV files contains local properties field headers, a line for each profile must be included in the file (even if this is an empty line). See the Profile Properties Dialog topic for more information on Profile Property fields.
|
||||||||||||||||||||||||||||||||
Profile index |
The P_DATETIME (date-time) column is optional, but if present must be on the left hand side of the event values. At least one of G_TS (the timestep value) and P_DATETIME must be provided. If G_TS value is not provided the P_DATETIME column will be used to deduce values for the subevent start time and timesteps. Subevents will be automatically created where changes in timestep intervals occur in the P_DATETIME column. The numbers following P_DATETIME in the header row number the profiles starting from 0. |
For an example of a Level Event CSV format file click below:
The table below describes the format of the CSV file including examples of each section of the file.
File Header Row |
Description |
||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
FILECONT TITLE |
FILECONT is a mandatory field which determines the type of event data contained in the file.
TITLE contains the name of the event item. |
||||||||||||||||||||||||||||||||||||
UserSettings UserSettingsValues |
Units and date-time format are specified in these fields. Units supported by InfoWorks ICM may be specified. Where units are not specified, InfoWorks ICM assumes values in the CSV file are in the current display units.
|
||||||||||||||||||||||||||||||||||||
Sub-Event Properties |
The fields describing sub-event (global) properties are as below. See the Sub-Event Properties Dialog topic for more details on Sub-Event Property fields. The G_NPROFILES field is mandatory. If this field is incorrect, data will not be imported as expected. At least one of G_TS (the timestep value) and P_DATETIME (the date-time column) must be provided. If both are present the G_TS value is used in conjunction with the G_START value to determine hydrograph timesteps and start time. All events
Inflow / Level / Regulator
Ground Infiltration
|
||||||||||||||||||||||||||||||||||||
Profile Properties |
The lines describing profile (local) properties are optional. If the CSV files contains local properties field headers, a line for each profile must be included in the file (even if this is an empty line). See the Profile Properties Dialog topic for more information on Profile Property fields. Level
Inflow
Regulator
Ground Infiltration
|
||||||||||||||||||||||||||||||||||||
Profile index |
The P_DATETIME (date-time) column is optional, but if present must be on the left hand side of the event values. At least one of G_TS (the timestep value) and P_DATETIME must be provided. If G_TS value is not provided the P_DATETIME column will be used to deduce values for the subevent start time and timesteps. Subevents will be automatically created where changes in timestep intervals occur in the P_DATETIME column. The numbers following P_DATETIME in the header row number the profiles starting from 0. |
For an example of a Pollutograph CSV format file click below:
The table below describes the format of the CSV file including examples of each section of the file.
File Header Row |
Description |
||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
FILECONT TITLE |
FILECONT is a mandatory field which determines the type of dterminant data contained in the file. The value is the abbreviated code displayed on the tabs in the pollutograph, e.g. BOD, COD DO, PH etc. TITLE contains the name of the event item. |
||||||||||||||||||||
UserSettings UserSettingsValues |
Units and date-time format are specified in these fields. Units supported by InfoWorks ICM may be specified. Where units are not specified, InfoWorks ICM assumes values in the CSV file are in the current display units.
|
||||||||||||||||||||
Sub-Event Properties |
The fields describing sub-event (global) properties are as below. See the Sub-Event Properties Dialog topic for more details on Sub-Event Property fields. The G_NPROFILES field is mandatory. If this field is incorrect, data will not be imported as expected. At least one of G_TS (the timestep value) and P_DATETIME (the date-time column) must be provided. If both are present the G_TS value is used in conjunction with the G_START value to determine hydrograph timesteps and start time.
|
||||||||||||||||||||
Profile Properties |
The lines describing profile (local) properties are optional. If the CSV files contains local properties field headers, a line for each profile must be included in the file (even if this is an empty line). See the Profile Properties Dialog topic for more information on Profile Property fields. Sediment input types
Dissolved determinant types
Attached determinant types
|
||||||||||||||||||||
Profile index |
The P_DATETIME (date-time) column is optional, but if present must be on the left hand side of the event values. At least one of G_TS (the timestep value) and P_DATETIME must be provided. If G_TS value is not provided the P_DATETIME column will be used to deduce values for the subevent start time and timesteps. Subevents will be automatically created where changes in timestep intervals occur in the P_DATETIME column. The numbers following P_DATETIME in the header row number the profiles starting from 0. |
For an example of a Waste Water / Trade Flow CSV format file click below:
The table below describes the format of the CSV file including examples of each section of the file.
- Rows must be in the order shown in the example above.
- Non-mandatory columns may be re-ordered or omitted.
- To include multiple profiles in one file, repeat rows from the PROFILE_NUMBER section onwards.
File Section |
Description |
---|---|
TITLE TITLE Example waste profile |
Optional field containing the name of the event item. |
Units_Concentration Units_Average_Flow Units_Concentration,Units_Average_Flow mg/l,l/day |
Units supported by InfoWorks ICM may be specified. Units_Average_Flow is applicable to Waste Water Events only. Where units are not specified, InfoWorks ICM assumes values in the CSV file are in the current display units. |
PROFILE_NUMBER PROFILE_DESCRIPTION FLOW PROFILE_NUMBER,PROFILE_DESCRIPTION,FLOW 1,Langley - separate,160 |
The PROFILE_NUMBER field is mandatory and must be in the left most column of the row. Profile numbers must be between 1 and 999 and must be unique to the file. PROFILE_DESCRIPTION contains a descriptive name for the profile. FLOW is interpreted as :
|
SEDIMENT, AVERAGE_CONCENTRATION SEDIMENT,AVERAGE_CONCENTRATION SF1,0 SF2,0 |
The SEDIMENT field is mandatory and must be in the left most column of the row. The AVERAGE_CONCENTRATION column contains the average concentration for the two available sediment fractions. |
POLLUTANT, DISSOLVED, SF1, SF2 POLLUTANT,DISSOLVED,SF1,SF2 BOD,0,0,0 COD,0,0,0 TKN,0,0,0 NH4,0,0,0 TPH,0,0,0 PL1,0,0,0 PL2,0,0,0 PL3,0,0,0 PL4,0,0,0 |
The POLLUTANT field is mandatory and must be in the left most column of the row. The DISSOLVED, SF1 and SF2 columns allows you to set base pollutant concentrations for the parameters in the list below |
CALIBRATION_WEEKDAY / CALIBRATION_WEEKEND / DESIGN_PROFILES TIME, FLOW, POLLUTANT CALIBRATION_WEEKDAY TIME,FLOW,POLLUTANT,SF1,SF2,BOD,COD,... 00:00,0.8,0 01:00,0.42,0 02:00,0.18,0 ... |
Use these sections to set up Weekday, Weekend and Design profiles. The CALIBRATION_WEEKDAY / CALIBRATION_WEEKEND / DESIGN_PROFILES field is required if the section is included in the file for import. The TIME column is mandatory if the section is included in the file for import and must be the left most column of the row. Separate sets of multiplier profiles can be defined for flows and pollutants. |
CALIBRATION_MONTHLY MONTH, FLOW, POLLUTANT CALIBRATION_MONTHLY MONTH,FLOW,POLLUTANT,SF1,SF2,BOD,COD,... JANUARY,1,0 FEBRUARY,1,0 MARCH,1,0 ... |
Use this section to set up Monthly profiles. The CALIBRATION_MONTHLY field is required if this section is included in the file for import and must be the left most column of the row. The MONTH column is mandatory if this section is included in the file for import. Separate sets of multiplier profiles can be defined for flows and pollutants. |
CALIBRATION_<DAY> TIME, FLOW POLLUTANT CALIBRATION_MONDAY TIME,FLOW,POLLUTANT,SF1,SF2,BOD,COD,... 00:00,0.9,0 01:00,0.5,0 02:00,0.2,0 ... |
Use these sections to set up profiles for individual days. The CALIBRATION_<DAY> field is required if the section is included in the file for import, where <DAY> is Monday, Tuesday, Wednesday etc. The TIME column is mandatory if the section is included in the file for import and must be the left most column of the row. Separate sets of multiplier profiles can be defined for flows and pollutants. |